cs-notifications-papi

📚 Data Dictionary - CS Notifications API

This section provides the meaning of the attributes included in the API.

🗂️ Base Information

• API Title: CS Membership User Migration
• Version: 1.0.0
• Base URL: https://cs-membership-user-migration-{env}.us-e1.cloudhub.io/api/Replace {env} with:
  • dev (Development)
  • qa (Quality Assurance)

🔑 API KEYS

• "Authorization": "Bearer {{API_KEY}}"Attribute defined in the request Header.

  • Type: String
  • Length: Minimum 36 characters, maximum 37 characters
  • Description: Authentication token required to access the API.

• "client_id": "{{CLIENT_ID}}"Attribute defined in the request Header.

  • Type: String
  • Length: Minimum 32 characters, maximum 36 characters
  • Description: Unique client identifier to authenticate the request.

NOTE: It is important to have these API KEYS to make any request to our services.

📧 Send an Email (POST /email)

• "files"

  • Type: File
  • Description: Attachment file to be sent along with the email (optional).

• "body"

  • Type: String (JSON)
  • Description: Contains the email structure, including recipient, subject, and message body.
  • Body Attributes:
    • "to": Recipient’s email address. (String, max 50 characters, RegEx [a-zA-Z0-9@._-])
    • "subject": Email subject. (String, max 100 characters, RegEx [a-zA-Z0-9 ])
    • "body": Message content. (String, max 500 characters, RegEx [a-zA-Z0-9 ])

• "base64"

  • Type: String
  • Description: Base64 encoded string to send embedded PDF files (optional).
  • Size: Max 2 MB
  • RegEx: [A-Za-z0-9+/=]

📲 Send an SMS (POST /sms)

• "to"

  • Type: String
  • Length: Minimum 10 characters, maximum 15 characters (including country code)
  • RegEx: [0-9+]
  • Description: Recipient’s phone number in international format.

• "message"

  • Type: String
  • Length: Max 160 characters
  • RegEx: [a-zA-Z0-9.,!? ]
  • Description: SMS message content to be sent.

📊 Get Notification Tracking (GET /email/notification-track)

• "filter"
  • Type: String (JSON)
  • Description: Filter to search for specific notifications.
  • Example:

    { "mail_to": "user@example.com" }

  • Filter Attributes:
    • "mail_to": Recipient’s email address. (String, max 50 characters, RegEx [a-zA-Z0-9@._-])
    • "status": Notification status. (String, allowed values: sent, delivered, failed)

🔐 Security Schemes

Client ID Enforcement

OAuth 2.0

⚠️ Common Error Codes

📞 Support

For any questions or issues, please contact the API support team COORDINACION DESARROLLO DE SERVICIOS Y APLICACIONES DE INTEGRACIONES.

Notes

• Documentation adjusted in February 2025.
• For additional information, contact: epalma@fgs.co